remove required if default in Service, update spec and add openapi MANUL test - #304
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request modifies the Service model and its corresponding OpenAPI and manifest specifications by making the user, before, and after fields optional. The review highlights that removing these fields from the required list in the Service_Get OpenAPI schema may negatively impact API clients, as these fields are guaranteed by defaults in the model. Furthermore, suggestions were made to replace mutable list literals with the list callable for default values in the Python model to prevent potential side effects and maintain consistency.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/openapi/openapi_user.yaml (5524)
The removal of user (line 5524), before (line 5526), and after (line 5527) from the required list of the Service_Get schema appears to be a mistake. Service_Get is used for API responses (GET requests). Since these fields have default values defined in the model, they are guaranteed to be present in the response. Removing them from the required list weakens the API contract for clients, as they will now be treated as optional in generated client code.
It appears these fields should have been removed from the Service_Create schema (line 5742) and Service_Update schema (line 5967) instead, where they are currently still marked as required in this file.
genesis_core/elements/dm/models.py (1237-1238)
Improvement opportunity: use the list callable as the default instead of a mutable list literal [] to avoid potential issues with shared state across instances. This is also more consistent with the use of default=dict elsewhere in this file (e.g., line 155).
default=list,
genesis_core/elements/dm/models.py (1247-1248)
Improvement opportunity: use the list callable as the default instead of a mutable list literal [] to avoid potential issues with shared state across instances. This is also more consistent with the use of default=dict elsewhere in this file (e.g., line 155).
default=list,
6f50ef2 to
ea024f9
Compare
slashburygin
changed the title
slashburygin
changed the title
ea024f9 to
c21bc31
Compare
| info: | ||
| title: Genesis Core v1 Boot API | ||
| version: 0.1.dev205+g5e9177075.d20260327 | ||
| version: 0.0.3.dev0+g5365cb965.d20260417 |
There was a problem hiding this comment.
Seems it will be better to update this line only for release versions.
There was a problem hiding this comment.
ok, changed in all places to latest version at this moment and in the test
c21bc31 to
550d4b6
Compare
550d4b6 to
3109dc5
Compare
3 participants
No description provided.